Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Production OTA: Add link for offline keys (requirement) and reason for motivation to do static deltas #610

Merged
merged 2 commits into from
Oct 6, 2023
Merged

Production OTA: Add link for offline keys (requirement) and reason for motivation to do static deltas #610

merged 2 commits into from
Oct 6, 2023

Conversation

camilamacedo86
Copy link
Contributor

@camilamacedo86 camilamacedo86 commented Oct 3, 2023 •
edited
Loading

Signed-off-by: Camila Macedo [email protected]

Readiness

  • Merge (pending reviews)
  • Merge after date or event
  • Draft

Overview

Why merge this PR? What does it solve?

Checklist

Optional. Add a 'x' to steps taken.
You can fill this out after opening the PR. "Did I..."

  • Run spelling and grammar check, preferably with linter.
  • Avoid changing any header associated with a link/reference.
  • Step through instructions (or ask someone to do so).
  • Review for wordiness
  • Match tone and style of page/section.
  • Run make linkcheck.
  • View HTML in a browser to check rendering.
  • Use semantic newlines.
  • follow best practices for commits.
    • Descriptive title written in the imperative.
    • Include brief overview of QA steps taken.
    • Mention any related issues numbers.
    • End message with sign off/DCO line (-s, --signoff).
    • Sign commit with your gpg key (-S, --gpg-sign).
    • Squash commits if needed.
  • Request PR review by a technical writer and at least one peer.

Comments

Any thing else that a maintainer/reviewer should know.
This could include potential issues, rational for approach, etc.

@camilamacedo86 camilamacedo86 changed the title doc: clarifications regards tuf keys WIP doc: clarifications regards tuf keys Oct 3, 2023
@doanac
Copy link
Member

doanac commented Oct 3, 2023

Docs for 464ddee are browsable at: https://ci.foundries.io/projects/fio-docs/builds/2386/docs/artifacts/html/index.html

@doanac
Copy link
Member

doanac commented Oct 3, 2023

Docs for 34969c0 are browsable at: https://ci.foundries.io/projects/fio-docs/builds/2387/docs/artifacts/html/index.html

@doanac
Copy link
Member

doanac commented Oct 3, 2023

Docs for 7bd0383 are browsable at: https://ci.foundries.io/projects/fio-docs/builds/2388/docs/artifacts/html/index.html

@doanac
Copy link
Member

doanac commented Oct 3, 2023

Docs for c7d7727 are browsable at: https://ci.foundries.io/projects/fio-docs/builds/2389/docs/artifacts/html/index.html

@doanac
Copy link
Member

doanac commented Oct 3, 2023

Docs for 5b85a90 are browsable at: https://ci.foundries.io/projects/fio-docs/builds/2390/docs/artifacts/html/index.html

@doanac
Copy link
Member

doanac commented Oct 3, 2023

Docs for 6c433e1 are browsable at: https://ci.foundries.io/projects/fio-docs/builds/2391/docs/artifacts/html/index.html

@doanac
Copy link
Member

doanac commented Oct 3, 2023

Docs for 035fd34 are browsable at: https://ci.foundries.io/projects/fio-docs/builds/2392/docs/artifacts/html/index.html

@camilamacedo86 camilamacedo86 changed the title WIP doc: clarifications regards tuf keys doc: clarifications regards tuf keys Oct 3, 2023
@doanac
Copy link
Member

doanac commented Oct 3, 2023

Docs for f58974e are browsable at: https://ci.foundries.io/projects/fio-docs/builds/2393/docs/artifacts/html/index.html

@camilamacedo86 camilamacedo86 force-pushed the prod-weave-keys branch 2 times, most recently from 499ad8f to f2ce3da Compare October 3, 2023 13:30
@doanac
Copy link
Member

doanac commented Oct 3, 2023

Docs for 499ad8f are browsable at: https://ci.foundries.io/projects/fio-docs/builds/2394/docs/artifacts/html/index.html

@doanac
Copy link
Member

doanac commented Oct 3, 2023

Docs for f2ce3da are browsable at: https://ci.foundries.io/projects/fio-docs/builds/2395/docs/artifacts/html/index.html

@camilamacedo86 camilamacedo86 changed the title doc: clarifications regards tuf keys WIP doc: clarifications regards tuf keys Oct 3, 2023
vkhoroz
vkhoroz reviewed Oct 3, 2023
View reviewed changes
source/reference-manual/ota/production-targets.rst Outdated Show resolved Hide resolved
source/reference-manual/ota/production-targets.rst Outdated Show resolved Hide resolved
source/reference-manual/ota/production-targets.rst Show resolved Hide resolved
source/reference-manual/ota/production-targets.rst Outdated Show resolved Hide resolved
source/reference-manual/security/offline-keys.rst Outdated Show resolved Hide resolved
source/reference-manual/security/offline-keys.rst Outdated Show resolved Hide resolved
source/reference-manual/security/offline-keys.rst Outdated Show resolved Hide resolved
@mike-sul
Copy link
Contributor

mike-sul commented Oct 3, 2023

IMO, I would let customer support team representatives to judge about the given doc/TUF clarification. Personally, as for me, it's really hard to assess objectively this document explanation in terms of helping customers to grok the TUF stuff. The key reason, I've working with TUF many years and know our TUF related implementation from inside.

@caiotpereira @vanmaegima Please, look into this doc and provide your feedback.

@camilamacedo86 camilamacedo86 changed the title WIP doc: clarifications regards tuf keys Work in Progress (WIP) - Please do not review yet - Understanding Offline Factory TUF Keys Oct 3, 2023
@camilamacedo86 camilamacedo86 force-pushed the prod-weave-keys branch 3 times, most recently from e5dfd30 to 7f605f4 Compare October 3, 2023 22:28
@camilamacedo86

This comment was marked as resolved.

Sign in to view
@camilamacedo86 camilamacedo86 requested a review from vkhoroz October 3, 2023 22:32
@camilamacedo86 camilamacedo86 changed the title Work in Progress (WIP) - Please do not review yet - Understanding Offline Factory TUF Keys Understanding Offline Factory TUF Keys Oct 3, 2023
angolini
angolini approved these changes Oct 4, 2023
View reviewed changes
Copy link
Collaborator

@angolini angolini left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Only few minor suggestions, please ignore then if you think they don't fit!

source/reference-manual/ota/production-targets.rst Outdated Show resolved Hide resolved
source/reference-manual/ota/production-targets.rst Outdated Show resolved Hide resolved
source/reference-manual/security/offline-keys.rst Outdated Show resolved Hide resolved
@camilamacedo86 camilamacedo86 force-pushed the prod-weave-keys branch 2 times, most recently from f7e5e19 to 5e3313c Compare October 4, 2023 17:38
@vkhoroz
Note in 'Production Targets' section: Users are now informed about th…
6a18561 
…e necessity of obtaining the targets key, a prerequisite to proceed.

Signed-off-by: Camila Macedo <[email protected]>

Co-authored-by: vkhoroz <[email protected]>
vkhoroz
vkhoroz approved these changes Oct 4, 2023
View reviewed changes
Copy link
Member

@vkhoroz vkhoroz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm fine with the current version.

@kprosise needs to approve.

camilamacedo86
camilamacedo86 commented Oct 4, 2023
View reviewed changes
Copy link
Contributor Author

@camilamacedo86 camilamacedo86 left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In this PR, I've mainly let the text suggested by @vkhoroz , which seems to be appropriate. I believe this is the best approach. We can discuss other changes or additions in follow-up PRs.Sorry for any inconvenience or disturbance I may have caused.

Thank you for your attention and time
I hope it small nit changes are good to fly,
Please, let me know if any further changes would be required.

@camilamacedo86 camilamacedo86 changed the title Understanding Offline Factory TUF Keys Production OTA: Add link for offline keys (requirement) and reason for motivation to do static deltas Oct 4, 2023
kprosise
kprosise approved these changes Oct 5, 2023
View reviewed changes
Copy link
Contributor

@kprosise kprosise left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, just a couple small changes suggested

source/reference-manual/ota/production-targets.rst Outdated Show resolved Hide resolved
prudction targets: clarify reason for the recommendation
2bcd40e 
Signed-off-by: Camila Macedo <[email protected]>
Co-authored-by: Katrina Prosise <[email protected]>
@kprosise kprosise merged commit 0934204 into foundriesio:main Oct 6, 2023
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kprosise kprosise kprosise approved these changes

@vkhoroz vkhoroz vkhoroz approved these changes

@angolini angolini angolini approved these changes

@vanmaegima vanmaegima Awaiting requested review from vanmaegima

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@camilamacedo86 @doanac @mike-sul @angolini @vkhoroz @kprosise